Package com.cisco.pt.ipc.sim.impl
Class WirelessClientProcessImpl
java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.ProcessImpl
com.cisco.pt.ipc.sim.impl.WirelessCommonImpl
com.cisco.pt.ipc.sim.impl.WirelessClientProcessImpl
- All Implemented Interfaces:
IPCObject,Process,WirelessClientProcess,WirelessCommon
Information provided by the PKI file:
\class WirelessClientProcess
\brief WirelessClientProcess handles and manipulates wireless clients.
\example network().getDevice("PC0").getProcess("WirelessClient")
- Author:
- Auto-generated
-
Field Summary
Fields inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
accessMessage, ipcFactory, packetTracerSession -
Constructor Summary
ConstructorsConstructorDescriptionWirelessClientProcessImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage) -
Method Summary
Modifier and TypeMethodDescriptionbooleanaddProfile(String name, String ssid, WirelessNetworkType netType, MACAddress macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userid, String password, boolean bDHCPOn, boolean bDHCPv6On, IPAddress ipAddress, IPAddress subnet, IPAddress gateway, IPAddress DNS) Information provided by the PKI file:booleandeleteProfile(String name) Information provided by the PKI file:Information provided by the PKI file:getCurrentNetworkAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:Information provided by the PKI file:getProfile(String name) Information provided by the PKI file:getProfileAt(int index) Information provided by the PKI file:intInformation provided by the PKI file:booleansetCurrentProfile(String name, String ssid, WirelessNetworkType netType, MACAddress macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userid, String password, boolean bDHCPOn, boolean bDHCPv6On, IPAddress ipAddress, IPAddress subnet, IPAddress gateway, IPAddress DNS) Information provided by the PKI file:booleansetCurrentProfileStringIPs(String name, String ssid, WirelessNetworkType netType, String macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userId, String password, boolean bDHCPOn, boolean bDHCPv6On, String ipAddress, String subnet, String gateway, String DNS) Methods inherited from class com.cisco.pt.ipc.sim.impl.WirelessCommonImpl
getAuthenType, getEncryptType, getNetworkType, getPort, getRadioBand, getSsid, getStandardChannel, getWepProcess, getWideChannel, getWpaProcess, resetAllAssociations, setAuthenType, setEncryptType, setNetworkType, setPort, setRadioBand, setSsid, setStandardChannel, setWideChannelMethods inherited from class com.cisco.pt.ipc.sim.impl.ProcessImpl
getOwnerDeviceMethods inherited from class com.cisco.pt.ipc.impl.IPCObjectImpl
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSession, sendMessage, sendMessageWithReturn, translateToCommandStatusStringPairMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.cisco.pt.ipc.IPCObject
getAccessMessage, getClassName, getFactory, getObjectUUID, getPacketTracerSessionMethods inherited from interface com.cisco.pt.ipc.sim.Process
getOwnerDeviceMethods inherited from interface com.cisco.pt.ipc.sim.WirelessCommon
getAuthenType, getEncryptType, getNetworkType, getPort, getRadioBand, getSsid, getStandardChannel, getWepProcess, getWideChannel, getWpaProcess, resetAllAssociations, setAuthenType, setEncryptType, setNetworkType, setPort, setRadioBand, setSsid, setStandardChannel, setWideChannel
-
Constructor Details
-
WirelessClientProcessImpl
public WirelessClientProcessImpl(IPCFactory ipcFactory, PacketTracerSession packetTracerSession, IPCMessageLTV accessMessage)
-
-
Method Details
-
addProfile
public boolean addProfile(String name, String ssid, WirelessNetworkType netType, MACAddress macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userid, String password, boolean bDHCPOn, boolean bDHCPv6On, IPAddress ipAddress, IPAddress subnet, IPAddress gateway, IPAddress DNS) Information provided by the PKI file:
\brief Adds a wireless profile. \param name, the name for the wireless profile. \param ssid, the SSID of the access point. \param netType, the network type. Network types: eWirelessDisabled = 0x0, eWirelessB = 0x1, eWirelessG = 0x2, eWirelessBGMixed = 0x3, eWirelessN = 0x4, eWirelessA = 0x5, eWirelessMixed = 0x7 \param macAddress, the MAC address of the access point. \param authType, the authentication type. Authentication types: eAuthenNull = 0, eAuthenWep = 1, eAuthenWPA1_PSK = 2, eAuthenWPA1_EAP = 3, eAuthenWPA2_PSK = 4, eAuthenWPA2_EAP = 5, eAuthenOpen = 6 \param encryptType, the encryption type. Encryption types: eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, eEncryptAES = 4 \param wepKey, the WEP key. \param userid, the user ID for WPA enterprise. \param password, the password for WPA enterprise. \param bDHCPOn, true to enable DHCP, false to disable DHCP. \param bDHCPv6On, true to enable DHCPv6, false to disable DHCPv6. \param ipAddress, the IP address for the interface. \param subnet, the subnet mask for the interface. \param gateway, the default gateway for the interface. \param DNS, the DNS server for the interface. \return bool, true if successful, otherwise false.- Specified by:
addProfilein interfaceWirelessClientProcess- Parameters:
name- Takes in a parameter of namessid- Takes in a parameter of ssidnetType- Takes in a parameter of netTypemacAddress- Takes in a parameter of macAddressauthType- Takes in a parameter of authTypeencryptType- Takes in a parameter of encryptTypewepKey- Takes in a parameter of wepKeyuserid- Takes in a parameter of useridpassword- Takes in a parameter of passwordbDHCPOn- Takes in a parameter of bDHCPOnbDHCPv6On- Takes in a parameter of bDHCPv6OnipAddress- Takes in a parameter of ipAddresssubnet- Takes in a parameter of subnetgateway- Takes in a parameter of gatewayDNS- Takes in a parameter of DNS- Returns:
- boolean Returns a boolean
-
deleteProfile
Information provided by the PKI file:
\brief Deletes the wireless profile with the specified name. \param name, the name of the wireless profile of interest. \return bool, true if successful, otherwise false.- Specified by:
deleteProfilein interfaceWirelessClientProcess- Parameters:
name- Takes in a parameter of name- Returns:
- boolean Returns a boolean
-
getProfile
Information provided by the PKI file:
\brief Returns the wireless profile with the specified name. \param name, the name of the wireless profile of interest. \return WirelessProfile, the WirelessProfile object with the specified name.- Specified by:
getProfilein interfaceWirelessClientProcess- Parameters:
name- Takes in a parameter of name- Returns:
- WirelessProfile Returns a WirelessProfile
-
getProfileCount
public int getProfileCount()Information provided by the PKI file:
\brief Returns the number of wireless profiles. \return int, the number of wireless profiles.- Specified by:
getProfileCountin interfaceWirelessClientProcess- Returns:
- int Returns a int
-
getProfileAt
Information provided by the PKI file:
\brief Returns the wireless profile at the specified index. \param index, the index of the wireless profile of interest. \return WirelessProfile, the WirelessProfile object at the specified index.- Specified by:
getProfileAtin interfaceWirelessClientProcess- Parameters:
index- Takes in a parameter of index- Returns:
- WirelessProfile Returns a WirelessProfile
-
getCurrentProfile
Information provided by the PKI file:
\brief Returns the current wireless profile. \return WirelessProfile, the WirelessProfile object.- Specified by:
getCurrentProfilein interfaceWirelessClientProcess- Returns:
- WirelessProfile Returns a WirelessProfile
-
setCurrentProfile
public boolean setCurrentProfile(String name, String ssid, WirelessNetworkType netType, MACAddress macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userid, String password, boolean bDHCPOn, boolean bDHCPv6On, IPAddress ipAddress, IPAddress subnet, IPAddress gateway, IPAddress DNS) Information provided by the PKI file:
\brief Sets the current wireless profile with the specified settings. \param name, the name for the wireless profile. \param ssid, the SSID of the access point. \param netType, the network type. Network types: eWirelessDisabled = 0x0, eWirelessB = 0x1, eWirelessG = 0x2, eWirelessBGMixed = 0x3, eWirelessN = 0x4, eWirelessA = 0x5, eWirelessMixed = 0x7 \param macAddress, the MAC address of the access point. \param authType, the authentication type. Authentication types: eAuthenNull = 0, eAuthenWep = 1, eAuthenWPA1_PSK = 2, eAuthenWPA1_EAP = 3, eAuthenWPA2_PSK = 4, eAuthenWPA2_EAP = 5, eAuthenOpen = 6 \param encryptType, the encryption type. Encryption types: eEncryptNull = 0, eEncryptWep_64bit = 1, eEncryptWep_128bit = 2, eEncryptTKIP = 3, eEncryptAES = 4 \param wepKey, the WEP key. \param userid, the user ID for WPA enterprise. \param password, the password for WPA enterprise. \param bDHCPOn, true to enable DHCP, false to disable DHCP. \param bDHCPv6On, true to enable DHCPv6, false to disable DHCPv6. \param ipAddress, the IP address for the interface. \param subnet, the subnet mask for the interface. \param gateway, the default gateway for the interface. \param DNS, the DNS server for the interface. \return bool, true if successful, otherwise false.- Specified by:
setCurrentProfilein interfaceWirelessClientProcess- Parameters:
name- Takes in a parameter of namessid- Takes in a parameter of ssidnetType- Takes in a parameter of netTypemacAddress- Takes in a parameter of macAddressauthType- Takes in a parameter of authTypeencryptType- Takes in a parameter of encryptTypewepKey- Takes in a parameter of wepKeyuserid- Takes in a parameter of useridpassword- Takes in a parameter of passwordbDHCPOn- Takes in a parameter of bDHCPOnbDHCPv6On- Takes in a parameter of bDHCPv6OnipAddress- Takes in a parameter of ipAddresssubnet- Takes in a parameter of subnetgateway- Takes in a parameter of gatewayDNS- Takes in a parameter of DNS- Returns:
- boolean Returns a boolean
-
setCurrentProfileStringIPs
public boolean setCurrentProfileStringIPs(String name, String ssid, WirelessNetworkType netType, String macAddress, WirelessAuthenType authType, WirelessEncryptType encryptType, String wepKey, String userId, String password, boolean bDHCPOn, boolean bDHCPv6On, String ipAddress, String subnet, String gateway, String DNS) - Specified by:
setCurrentProfileStringIPsin interfaceWirelessClientProcess- Parameters:
name- Takes in a parameter of namessid- Takes in a parameter of ssidnetType- Takes in a parameter of netTypemacAddress- Takes in a parameter of macAddressauthType- Takes in a parameter of authTypeencryptType- Takes in a parameter of encryptTypewepKey- Takes in a parameter of wepKeyuserId- Takes in a parameter of userIdpassword- Takes in a parameter of passwordbDHCPOn- Takes in a parameter of bDHCPOnbDHCPv6On- Takes in a parameter of bDHCPv6OnipAddress- Takes in a parameter of ipAddresssubnet- Takes in a parameter of subnetgateway- Takes in a parameter of gatewayDNS- Takes in a parameter of DNS- Returns:
- boolean Returns a boolean
-
getCurrentNetworkCount
public int getCurrentNetworkCount()Information provided by the PKI file:
\brief Returns the number of current network wireless profiles. \return int, the number of current networks wireless profiles.- Specified by:
getCurrentNetworkCountin interfaceWirelessClientProcess- Returns:
- int Returns a int
-
getCurrentNetworkAt
Information provided by the PKI file:
\brief Returns the current network wireless profile at the specified index. \param index, the index of the current network wireless profile of interest. \return WirelessProfile, the WirelessProfile object at the specified index.- Specified by:
getCurrentNetworkAtin interfaceWirelessClientProcess- Parameters:
index- Takes in a parameter of index- Returns:
- WirelessProfile Returns a WirelessProfile
-
getCurrentApMac
Information provided by the PKI file:
\brief Returns the MAC address of the current access point. \return mac, the MAC address of the current access point.- Specified by:
getCurrentApMacin interfaceWirelessClientProcess- Returns:
- MACAddress Returns a MACAddress
-